7.3 查询应用列表
基本信息
Path:/api/v1/resource/queryAllResource
Method: GET
请求参数
Query
参数名称 | 是否必须 | 示例 | 备注 |
---|---|---|---|
pageSize | 非必须 | 20 | 每页数据数目 默认100 |
pageIndex | 非必须 | 1 | 当前页 从1开始 |
filter | 非必须 | name | 过滤条件,只能从 ['all', 'name', 'description', 'appAddress', 'accessAddress','creator', 'creatorRole','status']中选择。不传或者传空表示不添加过滤条件,即查询全部。 |
searchValue | 非必须 | test | 搜索关键字,不传或者传空表示不添加过滤条件,即查询全部 |
sortBy | 非必须 | 排序字段 | |
asc | 非必须 | 排序方式,1升序,0降序,默认升序 | |
isPage | 非必须 | '0'不需要分页,'1' 需要分页 |
请求示例
pageSize=20&pageIndex=1filter=all&searchValue=test&pageSize=20&pageIndex=1
返回数据
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
code | string | 必须 | 返回码,0代表成功 | ||
data | object | 必须 | 返回内容 | ||
├─ pageSize | number | 必须 | 页面条数 | ||
├─ pageIndex | number | 必须 | 页码 | ||
├─ count | number | 必须 | 应用数 | ||
├─ pageCount | number | 必须 | 总页数 | ||
├─ data | object[] | 必须 | 应用列表 | ||
├─├─ id | string | 必须 | 应用ID | ||
├─├─appAddress | string | 必须 | 应用地址(仅WEB应用) | ||
├─├─addressList | object[] | 必须 | 应用地址列表(仅隧道应用) | ||
├─├─├─ protocol | string | 非必须 | 协议 | tcp/udp/icmp/all | |
├─├─├─ host | string | 非必须 | 服务器地址 | ||
├─├─├─ port | string | 非必须 | 端口 | ||
├─├─accessModel | string | 必须 | 访问模式 | ||
├─├─accessAddress | string | 必须 | 访问地址 | ||
├─├─applyForInfo | object | 必须 | 用户申请信息 | ||
├─├─ ├─ content | string | 必须 | 告警内容 | ||
├─├─ ├─ accessReason | string[] | 必须 | 申请理由 | ||
├─ ├─ description | string | 非必须 | 描述 | ||
├─ ├─ groupId | string | 必须 | 所属应用分类ID | ||
├─ ├─ groupName | string | 必须 | 所属应用分类名称 | ||
├─ ├─ iconId | string | 必须 | 图标 | ||
├─ ├─ iconType | string | 必须 | 图标类型,只能属于['font', 'upload', 'capture']其一的值 | ||
├─ ├─ iconPath | string | 必须 | 图标路径名。如果类型为capture,则为抓取的url列表 | ||
├─ ├─ level | string | 必须 | 保密级别 | ||
├─ ├─ status | number | 必须 | 启用状态,0:禁用;1:启用 | ||
├─ ├─ baselineStatus | number | 必须 | 权限基线状态 | ||
├─ ├─ name | string | 必须 | 应用名称 | ||
├─ ├─ nodeGroupId | string | 必须 | 应用所属节点区域id | ||
├─ ├─ trustedCertId | string | 必须 | 授信证书id,仅web,TP-WEB | ||
├─ ├─ext | object | 非必须 | 扩展字段 | ||
├─ ├─ ├─paths | string [] | 必须 | 黑/白名单 | ||
├─├─├─ disableAccessAddressListen | number | 必须 | 前端地址是否只改写不监听(仅WEB应用) | ||
├─ ├─ ├─ reqRewriteAddress | string | 必须 | 后端地址高级配置自定义请求头(仅WEB应用) | ||
├─ ├─ ├─ pathStatus | number | 必须 | 名单状态 | ||
├─ ├─ ├─ ipStatus | number | 必须 | 限制ip状态 | ||
├─ ├─ ├─ allowIps | string [] | 必须 | 限制ip列表 | ||
├─├─ ├─ dependSites | object | 必须 | 依赖站点配置 | ||
├─├─ ├─ ├─ enable | number | 必须 | 开关 | ||
├─├─ ├─ ├─ panDomain | string | 必须 | 泛域名 | ||
├─├─ ├─ ├─ siteList | object [] | 必须 | 依赖站点 | ||
├─├─ ├─ ├─ ├─ appAddress | string | 必须 | 后端地址 | ||
├─├─ ├─ ├─ ├─ accessAddress | string | 必须 | 前端访问地址 | ||
├─├─ ├─ security | object | 必须 | 应用安全配置 | ||
├─├─ ├─ ├─ watermark | object | 必须 | 水印配置 | ||
├─├─ ├─ ├─ ├─ enable | number | 必须 | 开关 | ||
├─├─ ├─ ├─ netZone | object | 必须 | 网络区域限制 | ||
├─├─ ├─ ├─├─ enable | string | 必须 | 0 表示关闭区域限制,1表示开启区域限制(限制为ids里面的区域) | ||
├─├─ ├─ ├─ ├─ ids | string [] | 必须 | 限制的网络区域id | ||
├─├─├─ openModel | object | 必须 | 打开方式 | ||
├─├─├─├─ model | string | 必须 | 方式 | ||
├─├─├─├─ programName | string | 必须 | 程序名称 | ||
├─├─├─├─ processName | string | 必须 | 进程名 | ||
├─├─├─├─ issuerName | array | 必须 | 签名者名称 | ||
├─├─├─├─ originalFilename | string | 必须 | 原始文件名 | ||
├─├─├─├─ useDefaultBrowser | string | 必须 | 允许在未找到该浏览器时自动打开默认浏览器 | ||
├─ ├─ ssoConfig | object | 必须 | 单点登录配置,无需关注 | ||
msg | string | 必须 | 描述信息 |
返回示例
{
"code": 0,
"data": {
"pageSize": 20,
"pageIndex": 1,
"count": 2,
"pageCount": 1,
"data": [{
"id": "c4f643f0-5717-11eb-b6e0-f7651d8dccc0",
"status": 1,
"accessModel": "L3VPN",
"name": "zcl_env",
"description": "",
"groupId": "default",
"appAddress": "",
"accessAddress": "",
"trustedCertId": "",
"protocol": "",
"nodeGroupId": "162a5d3c-2266-4643-9c50-c5e619fa7e6e",
"iconId": "1",
"level": "3",
"ext": "{\"paths\":[],\"readXFF\":0,\"allowIps\":[],\"dnsProxy\":{\"enable\":0,\"enableLan\":0,\"enableWan\":0},\"ipStatus\":0,\"pathType\":1,\"security\":{\"netZone\":{\"enable\":0},\"watermark\":{\"enable\":0}},\"pathStatus\":0,\"addressList\":[{\"host\":\"192.168.1.0/24\",\"port\":\"6440,4433,22\"}],\"dependSites\":{\"enable\":0,\"panDomain\":\"\",\"isPanDomainCert\":false},\"enableTransparentProxy\":0,\"disableAccessAddressListen\":0,\"openModel\":{\"model\":\"default-browser\",\"issuerName\":[],\"processName\":\"\",\"programName\":\"\",\"originalFilename\":\"\",\"useDefaultBrowser\":0,\"programDownloadUrl\":\"\"}}",
"addressList": [{
"host": "192.168.1.0/24",
"port": "6440,4433,22"
}],
"iconPath": "",
"iconType": "font",
"creator": "sdpc",
"creatorRole": "超级管理员",
"baselineStatus": 0,
"applyForInfo": "[object Object]"
}, {
"id": "0e8cec60-5585-11eb-9aa3-27b058cac48b",
"status": 1,
"accessModel": "L3VPN",
"name": "sdp控制台",
"description": "",
"groupId": "default",
"appAddress": "",
"accessAddress": "https://192.168.1.2:4433",
"trustedCertId": "",
"protocol": "",
"nodeGroupId": "162a5d3c-2266-4643-9c50-c5e619fa7e6e",
"iconId": "1",
"level": "3",
"ext": "{\"paths\":[],\"readXFF\":0,\"allowIps\":[],\"dnsProxy\":{\"enable\":0,\"enableLan\":0,\"enableWan\":0},\"ipStatus\":0,\"pathType\":1,\"security\":{\"netZone\":{\"ids\":[],\"enable\":0},\"watermark\":{\"enable\":0}},\"pathStatus\":0,\"addressList\":[{\"host\":\"192.168.1.2\",\"port\":\"4433,22\"}],\"dependSites\":{\"enable\":0,\"panDomain\":\"\",\"isPanDomainCert\":false},\"enableTransparentProxy\":0,\"disableAccessAddressListen\":0,\"openModel\":{\"model\":\"default-browser\",\"issuerName\":[],\"processName\":\"\",\"programName\":\"\",\"originalFilename\":\"\",\"useDefaultBrowser\":0,\"programDownloadUrl\":\"\"}}",
"addressList": [{
"host": "192.168.1.2",
"port": "4433,22"
}],
"iconPath": "",
"iconType": "font",
"creator": "sdpc",
"creatorRole": "超级管理员",
"baselineStatus": 0,
"applyForInfo": "[object Object]"
}]
},
"msg": "请求成功"
}
错误信息
错误提示 | 错误码 |
---|---|
参数检查出错 | 10000001 |